home *** CD-ROM | disk | FTP | other *** search
/ Aminet 7 / Aminet 7 - August 1995.iso / Aminet / util / time / TitleClock1001.readme < prev    next >
Text File  |  1995-07-02  |  11KB  |  282 lines
  1. Short:    V1.08,WB Titleclock, very configurable
  2. Author:   henryk.richter@stud.uni-rostock.de
  3. Uploader: henryk.richter@stud.uni-rostock.de
  4. Type:     util/time
  5.  
  6.  
  7.                        TitleClock 1.08 (30-May-95)
  8.                        ---------------------------
  9.                         by Henryk "Buggs" Richter
  10.  
  11.  
  12. Purpose
  13. -------
  14.  
  15. TitleClock is just another little Workbench Title digital clock but this
  16. time with some special features. I know that there are 1000 other ones out
  17. doing the same job but mine can do a little bit more. It was written to
  18. be used in combination tools like with "MultiCX" by Martin Berndt to replace
  19. almost all really important functions of programs like "Kcommodity" but
  20. consuming much less memory. It works 100% conform to the style guide and
  21. does not patch any system function. So it should run on any machine equipped
  22. with OS2.x/3.x. 
  23.  
  24.  
  25. A short list of features:
  26. -------------------------
  27.  
  28. - almost completely configurable output, e.g.
  29.   "OutPutFormat=%W, Time: %h:%n:%s  %D-%m-%Y ->DFT Rulez<-" causes it showing
  30.   "Saturday, Time: 20:42:12  10-Dec-1994 ->DFT Rulez<-"
  31. - appears at the right side of the workbench title and doesn`t open a
  32.   disturbing window
  33. - Workbench screen may be closed meanwhile Titleclock is active so you can
  34.   change your prefs without having to close any window.
  35. - Supports a "MEM"-gauge with a variable size from 10 Pixels to 990 Pixels
  36.   wide + selectable memory type to show
  37. - The program is a commodity so you can control it using Commodities
  38.   Exchange.
  39. - Can be easily removed by starting it again or sending a "break" signal
  40.   using a usual system monitor.
  41. - 100% font sensitive
  42. - detects automatically the colors used in titlebar
  43. - comes along with Icons for NewIcons AND MagicWB
  44. - re-entrant, 100% PC relative code
  45. - locale support using the standard strings so that this program works with
  46.   every localized language (Kick 2.1+)
  47. - startable from either WB or Shell
  48. - option to calculate the Stardate (TNG Norm)
  49. - quite short !! Hey, C and E programmers! Try to do this by using your
  50.   High-level languages, hehe
  51.  
  52.  
  53. Installation:
  54. -------------
  55.  
  56. Just drag the icon into the drawer you want. (usually sys:WBStartup)
  57.  
  58.  
  59. Starting:
  60. ---------
  61.  
  62. Double click onto the Icon. (What else)
  63.  
  64.  
  65. Configuration:
  66. --------------
  67.  
  68. The program countains no gui. This saves lots of memory from being wasted.
  69. Therefore the configuration is done using the tooltypes.
  70.  
  71.  
  72. OutPutFormat=????     Here you enter the line for your output string
  73.                       template. You may use any printable character and
  74.                       some offered variables. Those may be combined in any
  75.                       way you like (double, triple or even four times, no
  76.                       problem).
  77.                       The special variables:
  78.  
  79.                       %h -> hours in 24h military/European format
  80.                       %H -> hours in 12h American format
  81.                       %a -> "AM"/"PM"
  82.  
  83.                       %n -> minutes
  84.                       %s -> seconds
  85.  
  86.                       %D -> day
  87.  
  88.                       %N -> month as number
  89.                       %m -> month as short string (Jan,Feb,Mar...)
  90.                       %M -> month as string
  91.  
  92.                       %y -> year as 2 decimal numbers "94"
  93.                       %Y -> year as 4 decimal numbers "1994"
  94.  
  95.                       %w -> weekday as short string (Mon,Tue,Wed...)
  96.                       %W -> weekday as string
  97.  
  98.                       %% -> Just inserts a "%" char
  99.  
  100.                       %S -> Startrek TNG Stardate
  101.                             Descriptions of the algorithms can be found in
  102.                             the TNG and TOS Startrek FAQ`s
  103.                             Short explanation how I did it:
  104.                              example output: "05085.6"
  105.                             -the first digit is the current century (2"0"th)
  106.                             -the second is the Startrek season in the
  107.                              series and the movies. I used the last digit
  108.                              of the current year here since it is stated in
  109.                              the FAQ that this one increases every year
  110.                             -the next 3 digits are the portion of the
  111.                              current year from 0...999, which means:
  112.                              number of the current day (0..365) *1000/365
  113.                             -the ".6" represents the portion of the actual
  114.                              day divided through "2.4".
  115.                             If someone tells me how to convert gregorian
  116.                             date into the julian calendar, I`ll perhaps add
  117.                             an option for the TOS Stardate.
  118.  
  119.  
  120.  
  121.   Examples: OutPutFormat=Time: %h:%n%:%s  Date: %D-%M-%Y
  122.             OutPutFormat=This day is %h hours, %n minutes and %s seconds old
  123.             OutPutFormat=%W, %N-%D-%y %h:%n:%s
  124.  
  125. Gauge=??              This tooltype is for the mem bar showing the amount
  126.                       of free memory. If the (normally blue) bar reaches
  127.                       the right side, your memory is full. :(
  128.                       You may change the width of this gauge by entering
  129.                       values from 1 to 99. A value of 1 represents a width
  130.                       of 10 pixels.
  131.   Example: Gauge=5
  132.  
  133. Memtype=0x??          Here you can enter a c-style hexadecimal mask which
  134.                       type of mem is to be shown in the gauge. It works with
  135.                       standard exec-style Type definitions. (look into the
  136.                       examples, DUDE!)
  137.   Examples: Memtype=0x4   ... shows only free Fastmem
  138.             Memtype=0x2   ... shows only free Chipmem
  139.             Memtype=0x0   ... shows complete free memory
  140.             Memtype=0x1   ... shows Chip- and Fastmemory but not Virtual
  141.                               memory created e.g. by Gigamem® or VMM.
  142.             Memtype=0x20000 . shows largest free memory block
  143.             Memtype=0x20004 . shows largest free Fastmemory block
  144.             .
  145.             .
  146.             .
  147.  
  148.  
  149. Known Bugs / Problems
  150. ---------------------
  151.  
  152. Due to the display system blitting into the Workbench Titlebar Layer
  153. the display may disappear every time you change the current window or
  154. when the amount of free memory changes. I could change this behaviour
  155. but I didn`t want to open a window AND I hate too much patches.
  156.  
  157. If you set the Program`s "toolpri" lower than 0 it may/will happen that
  158. some programs using 100% of the CPU time (like PC-Task) can cause a 
  159. graphics deadlock. That happens when the blitter is already allocated by
  160. those functions used by Titleclock and then the CPU time is stolen by the
  161. Task with the higher priority. If you always use a priority of 5 (default
  162. setting) there shouldn`t be any problems. THE PROGRAM WILL NOT USE MORE 
  163. CPU TIME IN THIS CASE !
  164.  
  165.  
  166. History
  167. --------
  168.  
  169. 1.08 - Bugfix, the OS2.0/2.1 versions of Titleclock tried to open the V39
  170.        commodities.library instead of V37
  171.      - ASM-Sourcecode included
  172.  
  173. 1.07 - the program now be started from shell, the options are still read
  174.        from the Icon in this case
  175.      - small Bugfix, using the Kickstart 2.0/2.1 version it was possible
  176.        that the memgauge wasn`t shown correct when using non standard
  177.        screen widths
  178.  
  179. 1.06 - the AM/PM showed 12 AM at high noon instead of 12 PM, fixed
  180.  
  181. 1.05 - added the Stardate(TM) option
  182.  
  183. 1.04 - fixed a minor bug, I just forgot to free the workbench screen`s
  184.        drawinfo structure
  185.      - added 12h / PM displaying modes since I were asked to
  186.      *not released*
  187.  
  188. 1.03 - wrote a version for Kickstart 2.0 (english only)
  189.      - from Kick 2.1 onwards now localization supported
  190.      - added some additional security checks
  191.      - added the memtype option for the mem-gauge
  192.      - little "bug" fixed causing some characters not to be deleted when
  193.        using certain proportional fonts (added a space of 6 pixels)
  194.  
  195. 1.02 - added a version with german strings, made the code re-entrant to 
  196.        save some bytes
  197.  
  198. 1.01 - added the mem-gauge
  199.  
  200. 1.00 - first non public testrelease
  201.  
  202.  
  203. Author
  204. ------
  205.  
  206.                          Henryk Richter
  207.                          (Buggs/Defect)
  208.                      Stephan Jantzen Ring 47
  209.                          18106 Rostock
  210.                             Germany
  211.  
  212.            E-MAIL: tfa652@cks1.rz.uni-rostock.de
  213.                    henryk.richter@stud.uni-rostock.de
  214.                    buggs@baltic.e-technik.uni-rostock.de
  215.  
  216.  
  217. Legal Stuff
  218. -----------
  219.  
  220. Titleclock IS Freeware, so use it the way you like.
  221.  
  222.  
  223. Copyright
  224. ---------
  225.  
  226. Titleclock is written and copyright © 1994 by Henryk Richter. No parts of
  227. this program may be altered in any way (this includes editing, re-
  228. programming, crunching, resourceing etc.), except archiving.
  229.  
  230.  
  231. Disclaimer
  232. ----------
  233.  
  234.    THERE  IS  NO  WARRANTY  FOR  THE  PROGRAMS,  TO  THE  EXTENT  PERMITTED BY
  235. APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS
  236. AND/OR  OTHER  PARTIES  PROVIDE  THE  PROGRAMS "AS IS" WITHOUT WARRANTY OF ANY
  237. KIND,  EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  238. WARRANTIES  OF  MERCHANTABILITY  AND  FITNESS  FOR  A PARTICULAR PURPOSE.  THE
  239. ENTIRE  RISK  AS  TO  THE QUALITY AND PERFORMANCE OF THE PROGRAMS IS WITH YOU.
  240. SHOULD  THE  PROGRAMS  PROVE  DEFECTIVE,  YOU ASSUME THE COST OF ALL NECESSARY
  241. SERVICING, REPAIR OR CORRECTION.
  242.  
  243.    IN  NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL
  244. ANY  COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY REDISTRIBUTE THE PROGRAMS AS
  245. PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
  246. INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
  247. THE PROGRAMS (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED
  248. INACCURATE  OR  LOSSES  SUSTAINED  BY YOU OR THIRD PARTIES OR A FAILURE OF THE
  249. PROGRAMS  TO  OPERATE  WITH  ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
  250. PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  251.  
  252. Shorter: use it on your own risk...
  253.  
  254.  
  255. Distribution
  256. ------------
  257.  
  258. The Distributor may only charge a fee up to the costs of obtaining any
  259. common public domain disk. The distributor agrees to stop distributing the
  260. programs and data involved on request of the author.  The distributor may
  261. only distribute an unmodified copy of the original program, with all the
  262. supplied documentation and copyright notices left intact. The amount of
  263. US $5 shouldn't be exceeded for a disk containing Titleclock.
  264.  
  265.  
  266. ============================= Archive contents =============================
  267.  
  268. Original  Packed Ratio    Date     Time    Name
  269. -------- ------- ----- --------- --------  -------------
  270.     3035    1314 56.7% 30-May-95 18:55:56  Titleclock1001.info
  271.    10456    4500 56.9% 30-May-95 22:03:30 +TitleClock1001.doc
  272.     3040    2294 24.5% 30-May-95 18:55:42 +TitleClock1001.doc.info
  273.    26788    8167 69.5% 30-May-95 22:04:22 +TitleClock1001.s
  274.     3364    2317 31.1% 30-May-95 18:55:42 +TitleClock1001_2.0
  275.     3000    1546 48.4% 30-May-95 18:55:42 +TitleClock1001_2.0.info
  276.     3228    2243 30.5% 30-May-95 18:55:42 +TitleClock1001_2.1
  277.     3001    1548 48.4% 30-May-95 18:55:42 +TitleClock1001_2.1.info
  278.     3108    2147 30.9% 30-May-95 18:55:42 +TitleClock1001_3.x
  279.     3002    1551 48.3% 30-May-95 18:55:42 +TitleClock1001_3.x.info
  280. -------- ------- ----- --------- --------
  281.    62022   27627 55.4% 02-Jun-95 14:27:16   10 files
  282.